fix: correct typos in source and docs - #570
Open
TheGreatApollyon wants to merge 1 commit into
Open
Conversation
- Succesfully → Successfully (commands.py, migrations.md) - instace → instance (testing.md) - reccomend → recommend (migrations.md)
There was a problem hiding this comment.
Pull request overview
This PR cleans up several typos in Emmett’s migration CLI output strings and the related documentation, improving professionalism and keeping the docs aligned with actual command output.
Changes:
- Corrected “Succesfully” → “Successfully” in migration command output strings and in migration docs examples.
- Corrected “instace” → “instance” in the testing documentation.
- Corrected “reccomend” → “recommend” in the migrations documentation.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| emmett/orm/migrations/commands.py | Fixes user-facing CLI output typos for up/down/set migration commands. |
| docs/testing.md | Fixes a typo in the database fixture explanation text. |
| docs/orm/migrations.md | Fixes typos in migration docs narrative and command output examples. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| In the next sections we will describe all of this using the *bloggy* application we saw in the [tutorial chapter](../tutorial) as an example. | ||
|
|
||
| > **Note:** we **strongly reccomend** you to not enable automatic migrations on applications that run on production environments. The automatic migrations and the ones performed by the migration engine have some slight differences; while we will document operations supported by the second system, the detection performed by the automatic one depends on the [pydal](https://github.com/web2py/pydal) library, and are not officially supported by the Emmett development. If you need more informations about this you should check the [web2py docs](http://www.web2py.com/books/default/chapter/29/06/the-database-abstraction-layer#Migrations). | ||
| > **Note:** we **strongly recommend** you to not enable automatic migrations on applications that run on production environments. The automatic migrations and the ones performed by the migration engine have some slight differences; while we will document operations supported by the second system, the detection performed by the automatic one depends on the [pydal](https://github.com/web2py/pydal) library, and are not officially supported by the Emmett development. If you need more informations about this you should check the [web2py docs](http://www.web2py.com/books/default/chapter/29/06/the-database-abstraction-layer#Migrations). |
| ``` | ||
|
|
||
| As you can see, we called the `generate_runtime_migration` method with our application database instance, applied the generated migration before yielding the database instace, and reverted the migration immediately after. Every test function we'll write using this fixture, will have a migrated database to test. | ||
| As you can see, we called the `generate_runtime_migration` method with our application database instance, applied the generated migration before yielding the database instance, and reverted the migration immediately after. Every test function we'll write using this fixture, will have a migrated database to test. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes several typos across the codebase:
Succesfully→Successfully(commands.py, migrations.md)instace→instance(testing.md)reccomend→recommend(migrations.md)